<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
	<title>starts_with: common_schema documentation</title>
	<meta name="description" content="starts_with: common_schema" />
	<meta name="keywords" content="starts_with: common_schema" />
	<link rel="stylesheet" type="text/css" href="css/style.css" />
</head>

<body>
	<div id="main">
		<div id="header">
			<h1>common_schema</h1> <strong>2.2</strong> documentation
			<div class="subtitle">DBA's framework for MySQL</div>
		</div>
		<div id="contentwrapper">
			<div id="content">
				<h2><a href="starts_with.html">starts_with</a></h2>	
<h3>NAME</h3>
starts_with(): Checks whether given text starts with given prefix..
<h3>TYPE</h3>
Function

<h3>DESCRIPTION</h3>
<p>
	A string <i>p</i> is a prefix of <i>s</i> if there is a string <i>t</i>
	such that <strong>CONCAT(p, t) = s</strong>.
</p>

<h3>SYNOPSIS</h3>
<p>
<blockquote><pre>starts_with(txt TEXT CHARSET utf8, prefix TEXT CHARSET utf8)
  RETURNS INT UNSIGNED</pre></blockquote>
</p>
<p>
  Input:
  <ul>
    <li><strong>txt</strong>: an arbitrary text.</li>
    <li><strong>prefix</strong>: the string suspected/expected to be a prefix as <strong>txt</strong>.
	</li>
  </ul>
</p>
<p>
	If	<strong>txt</strong> does indeed start with <strong>prefix</strong>,
	<i>starts_with</i> returns the number of characters in the prefix. That is, the
	length of <strong>prefix</strong>.
</p>
<p>
	In case of mismatch (not a prefix), the function returns <strong>0</strong>.	 
</p>
<p>

	One should note that a positive number holds in SQL as a <strong>TRUE</strong> 
	value, whereas <strong>0</strong> holds as <strong>FALSE</strong>.
	Also note that in the particular case of the empty string being the
	<strong>prefix</strong>, the value <strong>0</strong> is always returned.	 
</p>

<h3>EXAMPLES</h3>
<p>Trim text (spaces between literals are unaffected):</p>
<blockquote><pre>SELECT starts_with('The quick brown fox', 'The quick') as is_prefix;
+-----------+
| is_prefix |
+-----------+
|         9 |
+-----------+
</pre></blockquote>

<p>Similar to the above, quoted for clarity:</p>
<blockquote><pre>SELECT starts_with('The quick brown fox', 'fox') as is_prefix;
+-----------+
| is_prefix |
+-----------+
|         0 |
+-----------+
</pre></blockquote>

</pre></blockquote>

<h3>ENVIRONMENT</h3>
MySQL 5.1 or newer

<h3>SEE ALSO</h3>
<a href="get_num_tokens.html">get_num_tokens()</a>,
<a href="split_token.html">split_token()</a>

<h3>AUTHOR</h3>
Shlomi Noach
				<br/>
			</div>
			<div id="sidebarwrapper">
				<div id="search">
					Search online documentation
					<form id="search_form" name="search_form" method="GET" 
						action="http://www.google.com/search" 
						onsubmit="document.forms['search_form']['q'].value = 'site:http://common-schema.googlecode.com/svn/trunk/common_schema/doc/html/ '+document.forms['search_form']['search_term'].value;">
						<input type="text" name="search_term" value=""/>
						<input type="hidden" name="q" value=""/>
						<input type="submit" value="go"/>						
					</form>
				</div>
				<div id="menu">
					<ul>
						<li><a title="Introduction" href="introduction.html">Introduction</a></li>
						<li><a title="Documentation" href="documentation.html">Documentation</a></li>
						<li><a title="Download" href="download.html">Download</a></li>
						<li><a title="Install" href="install.html">Install</a></li>
						<li><a title="Risks" href="risks.html">Risks</a></li>
					</ul>						
					<h3>QUERY SCRIPT</h3>
					<ul>
						<li><a title="QueryScript" href="query_script.html">QueryScript</a></li>
						<li><a title="Execution" href="query_script_execution.html">Execution</a></li>
						<li><a title="Flow control" href="query_script_flow_control.html">Flow control</a></li>
						<li><a title="Statements" href="query_script_statements.html">Statements</a></li>
						<li><a title="Expressions" href="query_script_expressions.html">Expressions</a></li>
						<li><a title="Variables" href="query_script_variables.html">Variables</a></li>
					</ul>						
					<h3>DEBUG</h3>
					<ul>
						<li><a title="rdebug" href="rdebug.html">rdebug</a></li>
						<li><a title="rdebug API" href="rdebug_api.html">rdebug API</a></li>
						<li><a title="rdebug workflow" href="rdebug_workflow.html">Workflow</a></li>
					</ul>						
					<h3>ROUTINES</h3>
					<ul>
						<li><a title="Execution &amp; flow control" href="execution_routines.html">Execution & flow control</a></li>
						<li><a title="General" href="general_routines.html">General</a></li>
						<li><a title="Process" href="process_routines.html">Process</a></li>
						<li><a title="Query analysis" href="query_analysis_routines.html">Query analysis</a></li>
						<li><a title="Schema analysis" href="schema_analysis_routines.html">Schema analysis</a></li>
						<li><a title="Security" href="security_routines.html">Security</a></li>
						<li><a title="Text" href="text_routines.html">Text</a></li>
						<li><a title="Time &amp; date" href="temporal_routines.html">Time & date</a></li>
						<li><a title="Charting" href="charting_routines.html">Charting</a></li>
					</ul>
					<h3>VIEWS</h3>
					<ul>
						<li><a title="Schema analysis" href="schema_analysis_views.html">Schema analysis</a></li>
						<li><a title="Data dimension" href="data_dimension_views.html">Data dimension</a></li>
						<li><a title="Process" href="process_views.html">Process</a></li>
						<li><a title="Security" href="security_views.html">Security</a></li>
						<li><a title="Monitoring" href="monitoring_views.html">Monitoring</a></li>
						<li><a title="InnoDB Plugin" href="innodb_plugin_views.html">InnoDB Plugin</a></li>
						<li><a title="Percona server" href="percona_server_views.html">Percona Server</a></li>
						<li><a title="TokuDB" href="tokudb_views.html">TokuDB</a></li>
					</ul>						
					<h3>DATA</h3>
					<ul>
						<li><a title="tables" href="tables.html">Tables</a></li>
						<li><a title="variables" href="variables.html">Variables</a></li>
					</ul>						
					<h3>META</h3>
					<ul>
						<li><a title="Help" href="help.html">help</a></li>
						<li><a title="Metadata" href="metadata.html">metadata</a></li>
						<li><a title="status" href="status.html">status</a></li>
					</ul>						
				</div>
			</div>	
			<div class="clear">&nbsp;</div>
			
			<div id="footnote" align="center">
				<a href="">common_schema</a> documentation
			</div>
		</div>
	</div>
</body>
</html>
